Document how this type of agent memorizes and deals with already seen mails.

Akinori MUSHA 10 years ago
parent
commit
ba36e9a267
1 changed files with 8 additions and 0 deletions
  1. 8 0
      app/models/agents/imap_folder_agent.rb

+ 8 - 0
app/models/agents/imap_folder_agent.rb

@@ -73,6 +73,14 @@ module Agents
73 73
           If this key is unspecified or set to null, it is ignored.
74 74
 
75 75
       Set `mark_as_read` to true to mark found mails as read.
76
+
77
+      Each agent instance memorizes a list of unread mails that are
78
+      found in the last run, so even if you change a set of conditions
79
+      so that it matches mails that are missed previously, they will
80
+      not show up as new events.  Also, in order to avoid duplicated
81
+      notification it keeps a list of Message-Id's of 100 most recent
82
+      mails, so if multiple mails of the same Message-Id are found,
83
+      you will only see one event out of them.
76 84
     MD
77 85
 
78 86
     event_description <<-MD